BrowseTree(IEasyAEClient,AEBrowseArguments,Func<IEnumerable<AENodeElement>,IEnumerable<AENodeElement>>) Method

Allows to traverse through OPC A&E address space nodes under the specified node, using given browse arguments, transforming the sequence of child node elements using a specified function.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal client As IEasyAEClient, _
   ByVal browseArguments As AEBrowseArguments, _
   ByVal nodeElementsTransformer As Func(Of IEnumerable(Of AENodeElement),IEnumerable(Of AENodeElement)) _
) As ITreeTraversable(Of AENodeTreePosition)

'Usage
 
Dim client As IEasyAEClient
Dim browseArguments As AEBrowseArguments
Dim nodeElementsTransformer As Func(Of IEnumerable(Of AENodeElement),IEnumerable(Of AENodeElement))
Dim value As ITreeTraversable(Of AENodeTreePosition)
 
value = IEasyAEClientExtension2.BrowseTree(client, browseArguments, nodeElementsTransformer)

[Extension()]
[NotNull()]
public static ITreeTraversable<AENodeTreePosition> BrowseTree( 
   IEasyAEClient client,
   AEBrowseArguments browseArguments,
   Func<IEnumerable<AENodeElement>,IEnumerable<AENodeElement>> nodeElementsTransformer
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<AENodeTreePosition^>^ BrowseTree( 
   IEasyAEClient^ client,
   AEBrowseArguments^ browseArguments,
   Func<IEnumerable<AENodeElement^>^,IEnumerable<AENodeElement^>^>^ nodeElementsTransformer
)

Parameters

client: The client object that will perform the operation.
browseArguments: Holds arguments needed to browse OPC A&E server nodes.
nodeElementsTransformer: Transforms a sequence of child node elements before it is used for further browsing.

Return Value

Returns an enumerator of tree positions that will traverse through all nodes specified.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument.

Remarks

If you want to enumerate through a sequence of the tree nodes, convert the result to a sequence using the OpcLabs.BaseLib.Graphs.Extensions.ITreeTraversableExtension.ToEnumerable<T> method.

The method automatically prevents recursion into nodes that have already been traversed.

The root position in a tree will correspond to the specified starting node. The OpcLabs.EasyOpc.AlarmsAndEvents.Graphs.AENodeTreePosition object for the root is special one, in that from its OpcLabs.EasyOpc.AlarmsAndEvents.AddressSpace.AENodeElement properties, only its QualifiedName is filled in.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012, Windows Server 2016; .NET Core, .NET 5, .NET 6: Linux, macOS, Microsoft Windows

Reference

IEasyAEClientExtension2 Class
IEasyAEClientExtension2 Members
Overload List